/***************************************************************************
 * Copyright 2012-2013 TXT e-solutions SpA
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * This work was performed within the IoT_at_Work Project
 * and partially funded by the European Commission's
 * 7th Framework Programme under the research area ICT-2009.1.3
 * Internet of Things and enterprise environments.
 *
 * Authors:
 *      Salvatore Piccione (TXT e-solutions SpA)
 *
 * Contributors:
 *        Domenico Rotondi (TXT e-solutions SpA)
 **************************************************************************/
package it.txt.ens.core.exception;

import java.text.MessageFormat;
import java.util.ResourceBundle;

/**
 * This exception represents a failure or error occurred when a client tries to establish
 * a communication session with the Event Notification Service.<br/>
 * The messages to be used with this exception are defined in a resource bundle.
 * 
 * @author Salvatore Piccione (TXT e-solutions SpA - salvatore.piccione AT txtgroup.com)
 * @author Domenico Rotondi (TXT e-solutions SpA - domenico.rotondi AT txtgroup.com)
 *
 */
public class ENSConnectionException extends Exception {
    
    private static final long serialVersionUID = -6081510345759460222L;
    private static final String MESSAGE_BUNDLE_LOCATION = "exception-messages/" + ENSConnectionException.class.getSimpleName();
    private static final ResourceBundle MESSAGES = ResourceBundle.getBundle(MESSAGE_BUNDLE_LOCATION);
    private final String code;
    private final String message;
    
    /**
     * Creates a new exception.
     * 
     * @param code the unique identifier of the message.
     */
    public ENSConnectionException (String code) {
        super();
        this.code = code;
        this.message = MessageFormat.format(MESSAGES.getString(code),(Object[])null);
    }

    /**
     * Creates a new exception.
     * 
     * @param code the unique identifier of the message to be associated with this exception.
     * @param cause the cause of the failure/error.
     */
    public ENSConnectionException (String code, Throwable cause) {
        super(cause);
        this.code = code;
        this.message = MessageFormat.format(MESSAGES.getString(code),(Object[])null);
    }
    
    /**
     * Creates a new exception.
     * 
     * @param code the unique identifier of the message to be associated with this exception.
     * @param cause the cause of the failure/error.
     * @param arguments the message arguments. It can be <code>null</code>.
     */
    public ENSConnectionException (String code, Throwable cause, Object ... arguments) {
        super(cause);
        this.code = code;
        this.message = MessageFormat.format(MESSAGES.getString(code),arguments);
    }
    
    /* (non-Javadoc)
     * @see java.lang.Throwable#getMessage()
     */
    @Override
    public String getMessage() {
        return this.message;
    }

    /**
     * Returns the code that uniquely identifies the message associated to this exception.
     * 
     * @return the code that uniquely identifies this exception's message.
     */
    public String getCode() {
        return code;
    }

}
